[Access] Add unit test for websocket controller #6762
Conversation
* Add unit test for websocket controller * Add mock for websocket connection * Add mock for data provider * Add mock for data provider factory * Add mock for websocket connection The WebSocket Controller interacts with: 1. Data Provider: Supplies data to the controller. 2. WebSocket Connection: Handles communication with the client. To properly test the controller's logic, we mock these interactions. Since the controller runs two parallel routines (reader and writer), the tests also ensure both can shut down cleanly. A done channel is used in the tests to coordinate this process.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6762 +/- ##
==========================================
+ Coverage 39.71% 41.23% +1.51%
==========================================
Files 1332 2064 +732
Lines 123050 182805 +59755
==========================================
+ Hits 48875 75383 +26508
- Misses 69986 101096 +31110
- Partials 4189 6326 +2137
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
There are no tests for error cases. I think we should add them as part of #6642. |
Guitarheroua
changed the title
| ) *Controller { | ||
| return &Controller{ | ||
| logger: logger.With().Str("component", "websocket-controller").Logger(), | ||
| config: config, | ||
| conn: conn, | ||
| communicationChannel: make(chan interface{}), //TODO: should it be buffered chan? | ||
| communicationChannel: make(chan interface{}, 10), //TODO: should it be buffered chan? |
There was a problem hiding this comment.
my preference is to not buffer this channel. there are buffers in the dp subscriptions already so I don't think we need additional layers of buffers
| }(c.conn) | ||
| c.shutdownOnce.Do(func() { | ||
| defer func() { | ||
| close(c.communicationChannel) |
There was a problem hiding this comment.
I don't think we should close this here. see discussion here: #6757 (comment)
| func (c *Controller) writeMessagesToClient(ctx context.Context) { | ||
| //TODO: can it run forever? maybe we should cancel the ctx in the reader routine | ||
| func (c *Controller) writeMessages(ctx context.Context) { | ||
| defer c.shutdownConnection() |
There was a problem hiding this comment.
this is deferred in both readMessages and writeMessages, which are both originally called in HandleConnection. you could avoid the synchronization you added in shutdownConnection by just calling it serially at the end of HandleConnection
| defer c.shutdownConnection() | ||
|
|
||
| for { | ||
| select { | ||
| case <-ctx.Done(): |
There was a problem hiding this comment.
is this no longer needed? Is the client connection guaranteed to exit?
| Topic: dp.Topic(), | ||
| ID: dp.ID().String(), | ||
| } | ||
| c.communicationChannel <- response |
There was a problem hiding this comment.
this should use a select to abort the push and return if the context is canceled.
| _, ok := <-done | ||
| if !ok { | ||
| return websocket.ErrCloseSent | ||
| } | ||
| return nil |
There was a problem hiding this comment.
can this return nil? if not, consider refactoring to make it clear for the next person to modify these tests
| _, ok := <-done | |
| if !ok { | |
| return websocket.ErrCloseSent | |
| } | |
| return nil | |
| <-done | |
| return websocket.ErrCloseSent |
| require.True(t, ok) | ||
| msg, err := json.Marshal(requestMessage) | ||
| require.NoError(t, err) | ||
| *reqMsg = msg |
| if !ok { | ||
| return websocket.ErrCloseSent | ||
| } | ||
| return nil |
There was a problem hiding this comment.
same comment about simplifying
Closes: #6635
The WebSocket Controller interacts with:
To properly test the controller's logic, we mock these interactions. Since the controller runs two parallel routines (reader and writer), the tests also ensure both can shut down cleanly.
A done channel is used in the tests to coordinate this process.